Skip to content

docs(contributors): update default branch info - #21

Merged
uniqueg merged 1 commit into
mainfrom
uniqueg-patch-1
Jul 22, 2024
Merged

uniqueg merged 1 commit into
mainfrom
uniqueg-patch-1

Conversation

@uniqueg

@uniqueg uniqueg commented Jul 22, 2024 •

Copy link
Copy Markdown
Member

Summary by Sourcery

This pull request updates the contributor guidelines to use the term 'default branch' instead of 'dev' branch, providing clarity on branch usage based on the project's release state.

  • Documentation:
    • Updated the contributor guidelines to reference the 'default branch' instead of specifically mentioning the 'dev' branch, clarifying that the default branch may vary depending on the project's release state.

@sourcery-ai

sourcery-ai Bot commented Jul 22, 2024 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide by Sourcery

This pull request updates the documentation to reflect changes in the default branch naming conventions. Specifically, it replaces references to the 'dev' branch with 'default branch' to accommodate different project setups where 'main' might be used directly as the default branch.

File-Level Changes

Files Changes
docs/guides/guide-contributor/general-guidelines.md Updated documentation to use 'default branch' terminology instead of 'dev' branch, reflecting more flexible project setups.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@uniqueg
uniqueg merged commit a7bc1d2 into main Jul 22, 2024
@uniqueg
uniqueg deleted the uniqueg-patch-1 branch July 22, 2024 14:47

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @uniqueg - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

state, i.e., those with version numbers below `v1.0.0`. Upon release,
`main` becomes the default branch, and [semantic versioning][sem-ver] is
strictly adhered by. In some cases, there may not be a `dev` branch and
`main` is used as the default branch straight away.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (documentation): Consider adding a comma for clarity.

Consider adding a comma after 'branch' for better readability: 'In some cases, there may not be a dev branch, and main is used as the default branch straight away.'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant